 AutoDoc Help Contents

The Contents list Help topics available for AutoDoc.Use the scroll bar to see entries not currently

visible in the Help window.To learn how to use Help, press F1 or choose Using Help from the

Help menu .

Contents

Project Selection Details

Documentation Details


Select Project
Project Selection Details

Project Name                                       Output Directory

Output Files                                           Statistics

Print                                                            Select Project

Browse                                                      Set Font

OK                                                                 Cancel

About                                                          Exit


It allows you to select any Project which consists of Forms and Modules stored in Ascii Format .

If Project Contains any Form or Module which is not stored in Ascii Format thenAutoDoc displays an

Error Message and Aborts Processing .

You can also select the  Project name through the Browse button or you can type the name of the

Project for which the Documentation is to be generated .


It allows you to select the Directory in which the output of the Documentation process is to be

stored .You can also choose the Directory through the Browse button.


Documentation Details.
 Documentation details

Following Documentation is generated for you .All the Files generated by the Auto

Documentation Application have the default  .ATD extension .

List of all Global Variables,Constants,Functions etc.

List of all Forms in the Project

Tree Structure

Statistics

Code on all controls


Details regarding the various Global Variables , Constants ,Functions and the Procedures used

by you within your Application which are stored in the ????GLOB.ATD File .


Details of the Forms used within your Project , Various controls used by you on the Forms and the

various events used by you on these controls .


Tree Structure
 Tree Structure details

This option helps to view a Tree Structure of your Project .i.e. the Project Name , the Forms list , the

controls on these forms etc. . A Tree Name can also be selected .

Tree Structure Menu

Expand One Level

Expand Branch

Expand All

Collapse Branch

Indicate Expandable Branches


You can Expand the Tree displaying contents upto the next available Level after the present Level


You can Expand the selected Branch displaying contents upto the next available Level after the

present Level for the selected Branch .


 You can Expand the Tree displaying contents of all the levels .


You can close the selected Branch .


It indicates all the levels those can be further expanded .Separate Icons are displayed for the

expandable and non - expandable items .


Statistics
 Statistics details

It allows you to view the Statistical details of the Documentation generated.

The information is stored in the ????STAT.ATD file in which the first 4 characters of the file name

comprise the name of the Project (.MAK) . e.g. If the Project Name is ICONWRKS.MAK the

Documentation file Name for Statistical information would be ICONSTAT.ATD.

The information details provided to the you are :-

- The Date on which the Documentation was generated .

- The Time at which the Documentation was generated .

- The Project contents like :-

- Number of Forms used .

- Number of Modules used .

- Number of Controls used .

- Number of Global Procedures .

- Number of Global Functions .

- Number of Global Variables .

- Number of Global Constants .

- The List of Output Files Generated.


File containing the Code written in all event procedures in the Project is generated with the file

name.as  ????DTLS.ATD .


Allows to select a Project name for which the Documentation is to be generated by displaying

list of Project Files .


Allows you to specify the Project Name for which the Documentation is to be generated .


Allows to Set different Fonts for Printing .


Print Details
 Printing details

Allows to Print all the the Ouput files generated . It also allows to Set Fonts for the Printing .

It allows the printing of the currently generated files for  -

Global Variables,Constants,Functions and Procedures .

All Controls and Events used on the Forms .

Code on each control on the Forms .

Tree Structure.

Statistics

You can also Select Other File


AboutBox displays the Information about AutoDoc such as AutoDoc  Developer's Name,

Information about available Memory , Liscense details etc.


Allows to Exit  the AutoDoc Application .


 Perssing OK indicates the confirmation of the Selection and directs the AutoDoc to carry on with

its work for the selection's made .


Pressing Cancel indicates the  non - confirmation of the Selections made and directs the

AutoDoc for the cancellation of the job.


If a Tree Structure is already generated then this can be used to View .All the Files with names

????TREE.ATD can be used for this purpose .


It displays all the activities in process for the Documentation generation .


If a Documentation File is already present the you can type the File name or select the file by using

the Browse button .All the *.ATD can be used for this purpose .


Allows to select a directory name in which the Documentation generated is to be stored .


Allows to select a documentation file name(*.ATD)  which is already generated by displaying

list of Project Files .